Fix always-failing Invoice::upcoming(...)
#131
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`Invoice::upcoming(...)` would always fail. The API call returns an
invoice that doesn't actually exist, and because it doesn't exist, it
doesn't have an `"id"` field in the response.
> Note that when you are viewing an upcoming invoice, you are simply
> viewing a preview – the invoice has not yet been created. As such, the
> upcoming invoice will not show up in invoice listing calls, and you
> cannot use the API to pay or edit the invoice. If you want to change the
> amount that your customer will be billed, you can add, remove, or update
> pending invoice items, or update the customer’s discount.
The lack of an `"id"` field causes the parsing of an `Invoice` to fail.
We can't do `struct Invoice { id: Option<InvoiceId> }` because the
`Object` trait expects the ID of the object to not be an option.
It seems like the least terrible option is to set `#[serde(default)]` on
the ID field and provide an empty string as an ID. While this isn't
great, it seems like the best of the bad options.
|
Note: I also logged this over at stripe/openapi#56 (comment) and Stripe is looking into what to do about this from an openapi standpoint. |
|
Thanks for logging an issue with stripe's openapi 😅 . I'll merge this into both |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Invoice::upcoming(...)would always fail. The API call returns aninvoice that doesn't actually exist, and because it doesn't exist, it
doesn't have an
"id"field in the response.The lack of an
"id"field causes the parsing of anInvoiceto fail.We can't do
struct Invoice { id: Option<InvoiceId> }because theObjecttrait expects the ID of the object to not be an option.It seems like the least terrible option is to set
#[serde(default)]onthe ID field and provide an empty string as an ID. While this isn't
great, it seems like the best of the bad options.